Skip to main content
Feedback

Add to Cache step

The Add to Cache step is used to add documents to a document cache so that they can be referenced later in the currently executing process or subprocess. The Add to Cache step references a Document Cache component, which describes how the cache is defined.

Add to Cache icon

The documents coming into the Add to Cache step must be of the same profile type as the one defined in the document cache. If the profile types do not match (for example, if flat files are sent to the step but the document cache uses an XML profile), you receive an error message when you run the process.

When the Document Cache component is used by the Add to Cache step:

  • All the values for all keys are loaded into the indexes. If any key values in the source documents are null or empty, the Add to Cache step fails, and you will receive an error.

  • Documents are indexed, which means they are organized by index and by key.

  • The indexes and documents are stored in the document cache.

note

When a document is added to a document cache, the entire document and all of the indexes for that document are stored.

If you have a flat file or database documents that contain many records, consider using the Data Process step's Split Documents process type to split the documents by line before adding them to the cache. Splitting documents by line enables you to map individual records from the cache.

Adding documents to a document cache

Use an Add to Cache step to add documents to a document cache so that you can reference them later in the currently executing process or in a subprocess.

Procedure

  1. Drag the Add to Cache step onto the process canvas. The Add to Cache step dialog opens.

  2. Enter a display name for the step in the Display Name field.

  3. Select or create a Document Cache component.

    Make sure that you select or create a Document Cache component that uses the same profile type as the documents being sent to the Add to Cache step.

    To learn more about Document Cache configuration and usage, refer to the following topics: Document cache configuration and usage and How the Document Cache step works.

  4. Click OK.

On this Page